4 * Holds tests for LoadBalancer MediaWiki class.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
24 use Wikimedia\Rdbms\DBError
;
25 use Wikimedia\Rdbms\DatabaseDomain
;
26 use Wikimedia\Rdbms\Database
;
27 use Wikimedia\Rdbms\LoadBalancer
;
28 use Wikimedia\Rdbms\LoadMonitorNull
;
32 * @covers \Wikimedia\Rdbms\LoadBalancer
34 class LoadBalancerTest
extends MediaWikiTestCase
{
35 public function testWithoutReplica() {
36 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
40 'host' => $wgDBserver,
41 'dbname' => $wgDBname,
42 'tablePrefix' => $this->dbPrefix(),
44 'password' => $wgDBpassword,
46 'dbDirectory' => $wgSQLiteDataDir,
48 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
52 $lb = new LoadBalancer( [
53 'servers' => $servers,
54 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
57 $ld = DatabaseDomain
::newFromId( $lb->getLocalDomainID() );
58 $this->assertEquals( $wgDBname, $ld->getDatabase(), 'local domain DB set' );
59 $this->assertEquals( $this->dbPrefix(), $ld->getTablePrefix(), 'local domain prefix set' );
61 $dbw = $lb->getConnection( DB_MASTER
);
62 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
63 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
64 $this->assertWriteAllowed( $dbw );
66 $dbr = $lb->getConnection( DB_REPLICA
);
67 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
68 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
70 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTO
);
71 $this->assertFalse( $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTO" );
72 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
73 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTO uses separate connection" );
75 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTO
);
76 $this->assertFalse( $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTO" );
77 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
78 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTO uses separate connection" );
80 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTO
);
81 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTO reuses connections" );
86 public function testWithReplica() {
87 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
91 'host' => $wgDBserver,
92 'dbname' => $wgDBname,
93 'tablePrefix' => $this->dbPrefix(),
95 'password' => $wgDBpassword,
97 'dbDirectory' => $wgSQLiteDataDir,
99 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
101 [ // emulated replica
102 'host' => $wgDBserver,
103 'dbname' => $wgDBname,
104 'tablePrefix' => $this->dbPrefix(),
106 'password' => $wgDBpassword,
108 'dbDirectory' => $wgSQLiteDataDir,
110 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
114 $lb = new LoadBalancer( [
115 'servers' => $servers,
116 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
117 'loadMonitorClass' => LoadMonitorNull
::class
120 $dbw = $lb->getConnection( DB_MASTER
);
121 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
123 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
124 $dbw->getLBInfo( 'clusterMasterHost' ),
125 'cluster master set' );
126 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
127 $this->assertWriteAllowed( $dbw );
129 $dbr = $lb->getConnection( DB_REPLICA
);
130 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
132 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
133 $dbr->getLBInfo( 'clusterMasterHost' ),
134 'cluster master set' );
135 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
136 $this->assertWriteForbidden( $dbr );
138 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTO
);
139 $this->assertFalse( $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTO" );
140 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
141 $this->assertNotEquals( $dbw, $dbwAuto, "CONN_TRX_AUTO uses separate connection" );
143 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTO
);
144 $this->assertFalse( $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTO" );
145 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
146 $this->assertNotEquals( $dbr, $dbrAuto, "CONN_TRX_AUTO uses separate connection" );
148 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTO
);
149 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTO reuses connections" );
154 private function assertWriteForbidden( Database
$db ) {
156 $db->delete( 'some_table', [ 'id' => 57634126 ], __METHOD__
);
157 $this->fail( 'Write operation should have failed!' );
158 } catch ( DBError
$ex ) {
159 // check that the exception message contains "Write operation"
160 $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
162 if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
163 // re-throw original error, to preserve stack trace
167 $db->rollback( __METHOD__
, 'flush' );
171 private function assertWriteAllowed( Database
$db ) {
172 $table = $db->tableName( 'some_table' );
174 $db->dropTable( 'some_table' ); // clear for sanity
175 // Use only basic SQL and trivial types for these queries for compatibility
176 $this->assertNotSame(
178 $db->query( "CREATE TABLE $table (id INT, time INT)", __METHOD__
),
181 $this->assertNotSame(
183 $db->query( "DELETE FROM $table WHERE id=57634126", __METHOD__
),
186 $this->assertNotSame(
188 $db->query( "DROP TABLE $table", __METHOD__
),
192 $db->rollback( __METHOD__
, 'flush' );
196 public function testServerAttributes() {
199 'dbname' => 'my_unittest_wiki',
200 'tablePrefix' => 'unittest_',
202 'dbDirectory' => "some_directory",
207 $lb = new LoadBalancer( [
208 'servers' => $servers,
209 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
210 'loadMonitorClass' => LoadMonitorNull
::class
213 $this->assertTrue( $lb->getServerAttributes( 0 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
218 'user' => 'wikiuser',
219 'password' => 'none',
220 'dbname' => 'my_unittest_wiki',
221 'tablePrefix' => 'unittest_',
225 [ // emulated replica
227 'user' => 'wikiuser',
228 'password' => 'none',
229 'dbname' => 'my_unittest_wiki',
230 'tablePrefix' => 'unittest_',
236 $lb = new LoadBalancer( [
237 'servers' => $servers,
238 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
239 'loadMonitorClass' => LoadMonitorNull
::class
242 $this->assertFalse( $lb->getServerAttributes( 1 )[Database
::ATTR_DB_LEVEL_LOCKING
] );